If I understand the change correctly, the following components have changed public API:

• NcReferencePicker
• NcSearch

This PR changes API for custom picker elements - the submit event sends reference as an object instead of a string link.

This change for the custom picker element is not backward compatible. An object cannot be used where the string was expected.

All the components using this result are updated to support both the new object result and the old string link result. All the components are backward compatible and support old custom picker elements.

However, they are not forward compatible. Older nextcloud-vue version will break with new custom picker element.

For example, new Collectives's PagePicker custom picker element emits submit event with { link, title }. Then an old nextcloud-vue's getLinkWithPicker handle it as a string link.

For the smart picker it results in creating '[object Object]' text node.

Proposal 1: instead of changing the existing submit event, add a new event, submit-reference or just pick.

Then custom picker elements can emit both events. Where supported, the new event with extra data will be used, and where not - the old event still works.

Later we can mark the old event as deprecated and remove.

this.$el.dispatchEvent(new CustomEvent('submit', {
	bubbles: true,
	detail: pageLink,
}))
this.$el.dispatchEvent(new CustomEvent('pick', {
	bubbles: true,
	detail: {
		link: pageLink,
		title: page.title,
	},
}))

Proposal 2: submit a string with additional link and title properties. So it is still a string, but we can extract the details

const result = 'https://nextcloud.com'
result.link = 'https://nextcloud.com'
result.title = 'Nextcloud'

Dirty. Hacky. Should work.

Proposal 3: emit an object with toString() method.

const result = {
  link: 'https://nextcloud.com',
  title: 'Nextcloud',
  toString() => 'https://nextcloud.com',
}

It is simpler, but will only work where the value is casted to string. For example, it works for the NcRichText with document.createTextNode(result). But it may not work for all the getLinkWithPicker users...